pac1811.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef PAC1811_H
#define PAC1811_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define PAC1811_REG_REFRESH                     0x00
#define PAC1811_REG_CTRL                        0x01
#define PAC1811_REG_ACC_COUNT                   0x02
#define PAC1811_REG_VACC                        0x03
#define PAC1811_REG_VBUS                        0x04
#define PAC1811_REG_VSENSE                      0x05
#define PAC1811_REG_VBUS_AVG                    0x06
#define PAC1811_REG_VSENSE_AVG                  0x07
#define PAC1811_REG_VPOWER                      0x08
#define PAC1811_REG_VBUS_MIN                    0x09
#define PAC1811_REG_VBUS_MAX                    0x0A
#define PAC1811_REG_VSENSE_MIN                  0x0B
#define PAC1811_REG_VSENSE_MAX                  0x0C
#define PAC1811_REG_VPOWER_MIN                  0x0D
#define PAC1811_REG_VPOWER_MAX                  0x0E
#define PAC1811_REG_CTRL_LAT                    0x0F
#define PAC1811_REG_NEG_PWR_FSR_LAT             0x10
#define PAC1811_REG_ALERT_STATUS                0x11
#define PAC1811_REG_SMBUS_SETTINGS              0x12
#define PAC1811_REG_NEG_PWR_FSR                 0x13
#define PAC1811_REG_REFRESH_G                   0x14
#define PAC1811_REG_REFRESH_V                   0x15
#define PAC1811_REG_SLOW                        0x16
#define PAC1811_REG_CTRL_ACT                    0x17
#define PAC1811_REG_NEG_PWR_FSR_ACT             0x18
#define PAC1811_REG_SLOW_ALERT1                 0x19
#define PAC1811_REG_GPIO_ALERT2                 0x1A
#define PAC1811_REG_ACC_FULLNESS_LIMITS         0x1B
#define PAC1811_REG_OC_LIMIT                    0x1C
#define PAC1811_REG_UC_LIMIT                    0x1D
#define PAC1811_REG_OP_WARNING_LIMIT            0x1E
#define PAC1811_REG_OP_CRITICAL_LIMIT           0x1F
#define PAC1811_REG_OV_LIMIT                    0x20
#define PAC1811_REG_UV_LIMIT                    0x21
#define PAC1811_REG_STEP_LIMIT                  0x22
#define PAC1811_REG_LIMIT_NSAMPLES              0x23
#define PAC1811_REG_ALERT_ENABLE                0x24
#define PAC1811_REG_ACCUMULATOR_COUNT_PRESET    0x25
#define PAC1811_REG_ACCUMULATOR_PRESET          0x26
#define PAC1811_REG_PRODUCT_ID                  0xFD
#define PAC1811_REG_MANUFACTURER_ID             0xFE
#define PAC1811_REG_REVISION_ID                 0xFF
 // pac1811_reg



#define PAC1811_FSR_UNIPOLAR                    0
#define PAC1811_FSR_BIPOLAR                     1
#define PAC1811_FSR_BIPOLAR_HALF                2

#define PAC1811_R9_RSENSE                       0.01
#define PAC1811_VSENSE_MAX                      0.1
#define PAC1811_VSOURCE_MAX                     42.0
#define PAC1811_FSC                             ( PAC1811_VSENSE_MAX / PAC1811_R9_RSENSE )
#define PAC1811_POWER_FSR                       ( PAC1811_FSC * PAC1811_VSOURCE_MAX )

#define PAC1811_PRODUCT_ID                      0x84
#define PAC1811_MANUFACTURER_ID                 0x54

#define PAC1811_DEVICE_ADDRESS_GENERAL_CALL     0x00
#define PAC1811_DEVICE_ADDRESS_A1A0_GND_GND     0x40
#define PAC1811_DEVICE_ADDRESS_A1A0_GND_VCC     0x41
#define PAC1811_DEVICE_ADDRESS_A1A0_VCC_GND     0x44
#define PAC1811_DEVICE_ADDRESS_A1A0_VCC_VCC     0x45
#define PAC1811_DEVICE_ADDRESS_A1A0_SDA_GND     0x48
#define PAC1811_DEVICE_ADDRESS_A1A0_SDA_VCC     0x49
#define PAC1811_DEVICE_ADDRESS_A1A0_SCL_GND     0x4C
#define PAC1811_DEVICE_ADDRESS_A1A0_SCL_VCC     0x4D
 // pac1811_set



#define PAC1811_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.a1_pin = MIKROBUS( mikrobus, MIKROBUS_PWM );
 // pac1811_map // pac1811

typedef struct
{
    uint32_t acc_count;         
    uint32_t acc_data_msb;      
    uint32_t acc_data_lsb;      
    float vbus;                 
    float isense;               
    float vbus_avg;             
    float isense_avg;           
    float power;                
    float vbus_min;             
    float vbus_max;             
    float isense_min;           
    float isense_max;           
    float power_min;            
    float power_max;            
 
} pac1811_data_t;

typedef struct
{
    // Output pins
    digital_out_t pwr;          
 
    // Input pins
    digital_in_t a1_pin;        
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
 
    uint8_t vsense_fsr;         
    uint8_t vbus_fsr;           
 
} pac1811_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t pwr;             
    pin_name_t a1_pin;          
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} pac1811_cfg_t;

typedef enum
{
    PAC1811_OK = 0,
    PAC1811_ERROR = -1
 
} pac1811_return_value_t;


void pac1811_cfg_setup ( pac1811_cfg_t *cfg );

err_t pac1811_init ( pac1811_t *ctx, pac1811_cfg_t *cfg );

err_t pac1811_default_cfg ( pac1811_t *ctx );

err_t pac1811_send_byte ( pac1811_t *ctx, uint8_t data_in );

err_t pac1811_receive_byte ( pac1811_t *ctx, uint8_t *data_out );

err_t pac1811_write_byte ( pac1811_t *ctx, uint8_t reg, uint8_t data_in );

err_t pac1811_read_byte ( pac1811_t *ctx, uint8_t reg, uint8_t *data_out );

err_t pac1811_block_write ( pac1811_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t pac1811_block_read ( pac1811_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );

err_t pac1811_check_communication ( pac1811_t *ctx );

void pac1811_enable_device ( pac1811_t *ctx );

void pac1811_disable_device ( pac1811_t *ctx );

uint8_t pac1811_get_a1_pin ( pac1811_t *ctx );

err_t pac1811_refresh ( pac1811_t *ctx );

err_t pac1811_refresh_global ( pac1811_t *ctx );

err_t pac1811_refresh_wo_acc_reset ( pac1811_t *ctx );

err_t pac1811_set_fsr ( pac1811_t *ctx, uint8_t vsense_fsr, uint8_t vbus_fsr );

err_t pac1811_read_data ( pac1811_t *ctx, pac1811_data_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // PAC1811_H
 // pac1811
 
// ------------------------------------------------------------------------ END